home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Tech Arsenal 1
/
Tech Arsenal (Arsenal Computer).ISO
/
tek-11
/
manual11.zip
/
README.2ND
< prev
next >
Wrap
Text File
|
1993-05-04
|
12KB
|
338 lines
-------------------------------------------------------------------
SUPERMANual - User Manual Creator
-------------------------------------------------------------------
Copyright (c) 1993
Auto-Jock Software
Eighteen 8th Street
Wheeling, WV 26003
(304) 232-1773
T a b l e o f C o n t e n t s
-------------------------------------------------------------------
WHY SUPERMANUAL.............................................1
USAGE - COMMAND LINE PARAMETERS.............................2
CONFIGURING SUPERMANUAL /C............................2
SUPERMANUAL VERSION /V................................3
SUPERMANUAL CREATE ...................................3
SUPERMANual - Users Manual Creator Pg. 1
-------------------------------------------------------------------
WHY SUPERMANUAL
---------------
SUPERMANual v.1.1 (5/3/93) - Is a Source Code util that creates
a complete Users Manual for editing with a word processor or
printing direct.
You place a special header file in your source and maintain all
text info for the manual in your source code. SUPERMANual will
extract and assemble your users manual for you.
This Manual was completely created with SUPERMANual. If you
would like to have an instant Users Manual, this is the program
for you.
If you are using the DEMO version, of SUPERMANual, you can print
up to a 6 page manual with Cover Page, Table of Contents, Index,
Header, Footer, Page Numbers and the 6 page manual.
You can register this program online on our support BBS by
calling 609-383-9400 14.4Kb 24 Hours, 9 Nodes.
Please Join Conference 8 - The Auto-Jock Conference
Thank you for using SUPERMANual. Written By Jim Barcus.
You can get support by calling 304-232-1773 noon to 7pm EST.
-------------------------------------------------------------------
(c)1993 A-J Software Version 1.1
SUPERMANual - Users Manual Creator Pg. 2
-------------------------------------------------------------------
USAGE - COMMAND LINE PARAMETERS
-------------------------------
Command Line Parameters
--------------------------------------------------------------
MANUAL filename.ext
Will add the [filename] text to the current manual file. Use
this format for each of your .prg, .c or .cpp files for your
application to the txt.dbf file.
--------------------------------------------------------------
MANUAL filename.ext /e
The /e switch will empty the txt.dbf file so you can start over.
--------------------------------------------------------------
MANUAL CREATE
Will create the finished Manual that is ready to print or ready
for your word processor.
--------------------------------------------------------------
MANUAL /c
To configure the manual that you are creating.
--------------------------------------------------------------
MANUAL /v
The SUPERMANual Version number will be displayed.
--------------------------------------------------------------
SUPERMANual will work with Clipper and dBase IV .prg files, .c
files and C++ files.
Simply add the extention for the Language that you use.
We have a special Version of SUPERMANual for FOXbase, dbase III+,
Clipper S87 and earlier version of clipper.
When you purchase SUPERMANuals, you get both versions.
CONFIGURING SUPERMANUAL /C
--------------------------
When you use the /c switch, you will see the following questions.
Enter the complete Program Name.
-------------------------------------------------------------------
(c)1993 A-J Software Version 1.1
SUPERMANual - Users Manual Creator Pg. 3
-------------------------------------------------------------------
Enter the copyright owner name.
Enter up to a three line description.
Header :
Footer :
The Program Name can be up to 65 charactors long and will be
centered on your CoverPage.
The Copyright Owner Name can be up to 50 charactors long and
will be centered on your CoverPage.
The Header can be up to 60 charactors long and will be located
on top of each manual page. (not CoverPage, TOC, Index) The
Header will also print the page # automatically.
The Footer can be up to 60 charactors long and will be located
at the bottom of each manual page. (not CoverPage, TOC, Index)
You can also place a 3 line decription of your program on the
front cover of the manual. These lines are all centered.
SUPERMANUAL VERSION /V
----------------------
When you use the /v switch, you will see a screen that shows you
the current version of SUPERMANual that you are using.
It will also show you the date version and our address and
phone numbers.
ADDING THE COMMENT BLOCK TO YOUR SOURCE CODE
--------------------------------------------
At every point in your program where you would like to add some
users manual text, you will have to add a comment block that look
like this:
$SUPERMAN$
$CHAPTER$
$SUBCHAPTER$
$HEADING$
$INDEXWORDS$
$TXT$
$END$
-------------------------------------------------------------------
(c)1993 A-J Software Version 1.1
SUPERMANual - Users Manual Creator Pg. 4
-------------------------------------------------------------------
The comment block is left justified and the spelling of the
words must be exactly as shown above.
$SUPERMAN$ - This tells SUPERMANual that it has found a
manual section and not just a normal program comment. This
MUST be the first line in the comment block.
----------------------------------------------------------------
$CHAPTER$ - This tells SUPERMANual what level to attach this
section of the manual to.
The word $CHAPTER$ MUST be under the $SUPERMAN$ word and
left. Directly under the $CHAPTER$ word MUST be the
Chapter Number. This is a whole number and up to 2 digits
wide.
----------------------------------------------------------------
$SUBCHAPTER$ - This tells SUPERMANual what Sub-level in the
current chapter to attach this section of the manual to.
The word $SUBCHAPTER$ MUST be under the chapter number and
left. Directly under the $SUBCHAPTER$ word MUST be the
Sub-Chapter Number. This is a whole number and up to 3
digits wide. This is the order in which this sub-chapter
falls in this chapter.
----------------------------------------------------------------
$HEADING$ - This tells SUPERMANual what the Name of this
level is.
The word $HEADING$ MUST be under the sub-chapter number and
left. Directly under the $HEADING$ word MUST be the
Heading Name. This is a charactor string up to 65 wide.
----------------------------------------------------------------
$INDEXWORDS$ - This tells SUPERMANual that some Index Page
Keywords are to follow. This is not requiered.
If you wish to include keywords, the word $INDEXWORDS$ MUST
be under the Heading Name and Left. Directly under the
$INDEXWORDS$ word MUST be the list of keywords. One Keyword
per line and up to 20 chrs per keyword.
$TXT$ - This tells SUPERMANual that this is the manual text.
Up to 65 chrs per line and an unlimited number of lines long.
$END$ - This tells SUPERMANual that this is the end of the
-------------------------------------------------------------------
(c)1993 A-J Software Version 1.1
SUPERMANual - Users Manual Creator Pg. 5
-------------------------------------------------------------------
manual text.
READING YOUR SOURCE CODE
------------------------
After you have run MANual /c to configure your manual and
you have added all of the comment blocks to your files, you will
be ready to start reading your files into SUPERMANual.
This step is very easy. Simply type:
MANUAL yourfile.ext [enter]
The Databases that SUPERMANual uses will be created the first
time you use this program.
If you should happen to read in the same file twice or make a
last minute change, you can use the /e switch after the file-
name.
IE: MANUAL yourfile.ext /e [enter]
This will allow you to start over from the first source file.
Just use this for adding each of your source files. This will
not take too long at all.
SUPERMANUAL CREATE
------------------
After you have run SUPERMANual on each of your commented source
code files, you can go to this final step.
You will end up with 4 ASCII files. The files are:
COVRPAGE.DOC
This is the cover page for your manual.
TOC.DOC
This is your Table of contents that goes just after the cover
page in the front of the manual.
MANUAL.DOC
This is the actual Users Manual. This is normally the largest
file of the 4 files created. If this is a DEMO version of
SUPERMANual, it will be 6 pages MAX.
-------------------------------------------------------------------
(c)1993 A-J Software Version 1.1